Skip to main content
PATCH
/
audiences
Update an audience
curl --request PATCH \
  --url https://your_a2_service/audiences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alt_id": {},
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "id_type": "<string>",
  "properties": {},
  "updated_at": "2023-11-07T05:31:56Z"
}'
{
  "alt_id": {},
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "id_type": "<string>",
  "properties": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Represents a audience entity.

id
string
required
alt_id
object | null

Alternate identifier for the audience

created_at
string<date-time> | null

The date and time the entity was created.

id_type
string | null
default:account_id

The type of the identifier

properties
object

Properties for the audience

The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Represents a audience entity.

id
string
required
alt_id
object | null

Alternate identifier for the audience

created_at
string<date-time> | null

The date and time the entity was created.

id_type
string | null
default:account_id

The type of the identifier

properties
object

Properties for the audience

The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
updated_at
string<date-time> | null

The date and time the entity was last updated.